Vapi Metadata Metamodel EnumerationValueInfo
Vapi Metadata Metamodel EnumerationValueInfo
The Vapi Metadata Metamodel EnumerationValueInfo schema describes the enumeration value in the enumerated type.
JSON Example
{
"value": "string",
"metadata": {
"metadata": {
"elements": {
"elements": {
"type": "string",
"long_value": 0,
"string_value": "string",
"list_value": [
"string"
],
"structure_id": "string",
"structure_ids": [
"string"
]
}
}
}
},
"documentation": "string"
}
string
value
Required
Value in the enumerated type. All the characters in the string are capitalized.
object
metadata
Required
Additional metadata for enumeration value in the enumerated type. The key in the map is the name of the metadata element and the value is the data associated with that metadata element.
The Vapi Metadata Metamodel MetadataIdentifier contains possible string values for keys in the map.
string
documentation
Required
English language documentation for an enumeration value. It can contain HTML markup and documentation tags (similar to Javadoc tags). The first statement will be a noun or verb phrase that describes the purpose of the enumeration value.